home *** CD-ROM | disk | FTP | other *** search
/ Aminet 28 / Aminet 28 (1998)(GTI - Schatztruhe)[!][Dec 1998].iso / Aminet / util / rexx / RXListReq.readme < prev    next >
Encoding:
Text File  |  1998-10-31  |  6.3 KB  |  114 lines
  1. Short:        Gadtools listview for AREXX. V1.0
  2. Author:       dickow@uidaho.edu (Robert Dickow)
  3. Uploader:     dickow@uidaho.edu (Robert Dickow)
  4. Version:      1.0
  5. Type:         util/rexx
  6. Distribution: World
  7. Basename:     rxlistreq
  8.  
  9. The rxlistreq executable in this archive was coded
  10. in pure Amiga JForth 3.1 over a couple of hot summer
  11. evenings.
  12.  
  13. This archive has an AREXX host and sample arexx script
  14. for an example of how to use AREXX and the supplied host
  15. program to allow your AREXX scripts to open a listview with
  16. a list of items of any size that you define. The user may
  17. click on an item to indicate a choice, or click on a CANCEL
  18. button or the window's close button, or hit HELP or the ESC
  19. key. All user input is returned to the calling program when
  20. the window is closed.
  21.  
  22. This program uses native GadTools gadgets, and at the moment
  23. there is no support for multiple selection or editing of
  24. items in the listview gadget. The program provides a simple
  25. but attractive window that is resizable as well as customizable
  26. from the rexx script for size, position, and label names. It
  27. uses the screen font by default. You can open it on your own
  28. public screens too.
  29.  
  30. Complete documentation is provided by the included rxlistreq.readme
  31. and is also included in the lvtest.rexx program.
  32.  
  33. Run the lvtest.rexx script by typing 'rx lvtest'. rxlistreq needs to
  34. be in the same directory as the arexx script lvtest.rexx unless you
  35. edit the script to define the full path to the host executable rxlistreq.
  36.  
  37. Enjoy!
  38.  
  39. Bob Dickow (dickow@uidaho.edu)
  40.  
  41. /* *********************************************** */
  42. /* lvtest.rexx                                     */
  43. /* Author: Bob Dickow (dickow@uidaho.edu)          */
  44. /* $VER: lvtest.rexx V1.0 (09.04.98)               */
  45. /* *********************************************** */
  46.  
  47. /* ************************************************************ */
  48. /*   Simple arexx script to test and demo rxlistreq host.       */
  49. /*   The host will display a gadtools listview in a window      */
  50. /*   and displays a list specified by the calling arexx script. */
  51. /*                                                              */
  52. /*   After the user clicks on an item or cancels the requester, */
  53. /*   the host will return control to the calling arexx program. */
  54. /* ************************************************************ */
  55.  
  56. /* *********************************************************************** */
  57. /* USAGE: Start up the rxlistreq host through a shell command, then        */
  58. /* address the host as ADDRESS "RXLISTREQ" (or if you want to specify      */
  59. /* a host name, add it after the shell callup of rxlistreq as a cli        */
  60. /* parameter: run rxlistreq LISTVIEW)                                      */
  61. /* Then 'send' the command, after using ADDRESS "<PORTNAME>" as:           */
  62. /*  rxlistreq <NUMBER_IN_LIST> <LIST_STEM_NAME> [WINDOW_PARMS_STEMNAME]    */
  63. /*                                                                         */
  64. /*  The last parameter is optional, and will default to "RXLV"             */
  65. /* Parameters:                                                             */
  66. /*  <NUMBER_IN_LIST>: This number tells the host to show a list with the   */
  67. /*      specified number of elements. The AREXX calling script or program  */
  68. /*      must declare a list as a stem variable indexed from 0, as in:      */
  69. /*      STEM.0 = "Hello" ; STEM.1 = "GOODBYE" ; STEM.2 = "342" ....        */
  70. /*      The host will use the stem name in the parameter, with no default  */
  71. /*      to fall back to.                                                   */
  72. /*  <LIST_STEM_NAME>: The AREXX stem variable name for the list of items.  */
  73. /*      This list should be indexed from 0, and may continue to any ex-    */
  74. /*      tent. The indexes should be successive integer numbers (1, 2 etc)  */
  75. /*  <WINDOW_PARMS_STEMNAME>: This is an optional stem variable name that   */
  76. /*      the script can use to pass various parameters for the listview     */
  77. /*      window display. The default stem is "RXLV". The choices are:       */
  78. /*                                                                         */
  79. /*  RXLV.LVLABEL       -- A String to place above the listview             */
  80. /*  RXLV.BUTTONLABEL   -- A String to place inside the CANCEL button       */
  81. /*  RXLV.XPOS          -- The screen X position to open the window         */
  82. /*  RXLV.YPOS          -- The screen Y position to open the window         */
  83. /*                        (if not specified, opens near the mouse pointer) */
  84. /*  RXLV.WIDTH         -- The desired width of the window                  */
  85. /*  RXLV.HEIGHT        -- The desired height of the window                 */
  86. /*                        (Will not be smaller than 150 x 200 pixels)      */
  87. /*  RXLV.SCREEN        -- Name of the public screen on which to display    */
  88. /*                        the window. Default is the Workbench.            */
  89. /* *********************************************************************** */
  90.  
  91. /* ***************************************************************************** */
  92. /* The rxlistreq host program returns the following variables, which will        */
  93. /* be created in the symbol table if not already declared:                       */
  94. /* [RXLV].CLICKED = number of the item chosen, unset if user cancels or quits.   */
  95. /* [RXLV].EXIT    = key (or the close gadget) that the user used to exit, if     */
  96. /*    the user decides to abort the window and not make a choice from the        */
  97. /*    list. Currently the user may abort by clicking the close gadget or         */
  98. /*    the CANCEL button gadget, or by typing the ESC key or the HELP key.        */
  99. /*    EXITCHOICE will be set to strings "CANCEL, CLOSE, ESC, or HELP"            */
  100. /*    respectively, or to LIST if the listview is clicked.                       */
  101. /* ***************************************************************************** */
  102.  
  103.  
  104. ============================= Archive contents =============================
  105.  
  106. Original  Packed Ratio    Date     Time    Name
  107. -------- ------- ----- --------- --------  -------------
  108.     2657     629 76.3% 04-Sep-98 02:06:42  RXListReq.info
  109.     5579    1934 65.3% 04-Sep-98 02:05:44 +lvtest.rexx
  110.    22088    8434 61.8% 04-Sep-98 02:05:44 +rxlistreq
  111.     5895    2106 64.2% 04-Sep-98 02:05:44 +rxlistreq.readme
  112. -------- ------- ----- --------- --------
  113.    36219   13103 63.8% 08-Sep-98 14:00:34   4 files
  114.